<!DOCTYPE HTML>

<html lang="en">
<head>

<title>OpenIDAuthenticationFilter (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="OpenIDAuthenticationFilter (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":42,"i1":42,"i2":42,"i3":42,"i4":42,"i5":42,"i6":42,"i7":42,"i8":42};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="OpenIDAuthenticationFilter.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="OpenIDAuthenticationFilter.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="OpenIDAuthenticationFilter.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="OpenIDAuthenticationFilter.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="OpenIDAuthenticationFilter.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="OpenIDAuthenticationFilter.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="OpenIDAuthenticationFilter.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.openid</a></div>
<h2 title="Class OpenIDAuthenticationFilter" class="title">Class OpenIDAuthenticationFilter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.web.filter.GenericFilterBean</li>
<li>
<ul class="inheritance">
<li><a href="../web/authentication/AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter</a></li>
<li>
<ul class="inheritance">
<li>org.springframework.security.openid.OpenIDAuthenticationFilter</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>javax.servlet.Filter</code>, <code>org.springframework.beans.factory.Aware</code>, <code>org.springframework.beans.factory.BeanNameAware</code>, <code>org.springframework.beans.factory.DisposableBean</code>, <code>org.springframework.beans.factory.InitializingBean</code>, <code>org.springframework.context.ApplicationEventPublisherAware</code>, <code>org.springframework.context.EnvironmentAware</code>, <code>org.springframework.context.MessageSourceAware</code>, <code>org.springframework.core.env.EnvironmentCapable</code>, <code>org.springframework.web.context.ServletContextAware</code></dd>
</dl>
<hr>
<pre>@Deprecated
public class <span class="typeNameLabel">OpenIDAuthenticationFilter</span>
extends <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">AbstractAuthenticationProcessingFilter</a></pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">The OpenID 1.0 and 2.0 protocols have been deprecated and users are
<a href="https://openid.net/specs/openid-connect-migration-1_0.html">encouraged to
migrate</a> to <a href="https://openid.net/connect/">OpenID Connect</a>, which is
supported by <code>spring-security-oauth2</code>.</div>
</div>
<div class="block">Filter which processes OpenID authentication requests.
<p>
The OpenID authentication involves two stages.
<h2>Submission of OpenID identity</h2>
The user's OpenID identity is submitted via a login form, just as it would be for a
normal form login. At this stage the filter will extract the identity from the
submitted request (by default, the parameter is called <tt>openid_identifier</tt>, as
recommended by the OpenID 2.0 Specification). It then passes the identity to the
configured <tt>OpenIDConsumer</tt>, which returns the URL to which the request should
be redirected for authentication. A "return_to" URL is also supplied, which matches the
URL processed by this filter, to allow the filter to handle the request once the user
has been successfully authenticated. The OpenID server will then authenticate the user
and redirect back to the application.
<h2>Processing the Redirect from the OpenID Server</h2>
Once the user has been authenticated externally, the redirected request will be passed
to the <tt>OpenIDConsumer</tt> again for validation. The returned
<tt>OpenIDAuthentication</tt> will be passed to the <tt>AuthenticationManager</tt>
where it should (normally) be processed by an <tt>OpenIDAuthenticationProvider</tt> in
order to load the authorities for the user.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="OpenIDAuthenticationProvider.html" title="class in org.springframework.security.openid"><code>OpenIDAuthenticationProvider</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">

</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OpenIDAuthenticationFilter.html#DEFAULT_CLAIMED_IDENTITY_FIELD">DEFAULT_CLAIMED_IDENTITY_FIELD</a></span></code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter">

</a>
<h3>Fields inherited from class&nbsp;org.springframework.security.web.authentication.<a href="../web/authentication/AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">AbstractAuthenticationProcessingFilter</a></h3>
<code><a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#authenticationDetailsSource">authenticationDetailsSource</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#eventPublisher">eventPublisher</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#messages">messages</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.springframework.web.filter.GenericFilterBean">

</a>
<h3>Fields inherited from class&nbsp;org.springframework.web.filter.GenericFilterBean</h3>
<code>logger</code></li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">

</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="OpenIDAuthenticationFilter.html#%3Cinit%3E()">OpenIDAuthenticationFilter</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OpenIDAuthenticationFilter.html#afterPropertiesSet()">afterPropertiesSet</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OpenIDAuthenticationFilter.html#attemptAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">attemptAuthentication</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
javax.servlet.http.HttpServletResponse&nbsp;response)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Authentication has two phases.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OpenIDAuthenticationFilter.html#buildReturnToUrl(javax.servlet.http.HttpServletRequest)">buildReturnToUrl</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Builds the <tt>return_to</tt> URL that will be sent to the OpenID service provider.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OpenIDAuthenticationFilter.html#lookupRealm(java.lang.String)">lookupRealm</a></span>&#8203;(java.lang.String&nbsp;returnToUrl)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OpenIDAuthenticationFilter.html#obtainUsername(javax.servlet.http.HttpServletRequest)">obtainUsername</a></span>&#8203;(javax.servlet.http.HttpServletRequest&nbsp;req)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Reads the <tt>claimedIdentityFieldName</tt> from the submitted request.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OpenIDAuthenticationFilter.html#setClaimedIdentityFieldName(java.lang.String)">setClaimedIdentityFieldName</a></span>&#8203;(java.lang.String&nbsp;claimedIdentityFieldName)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">The name of the request parameter containing the OpenID identity, as submitted from
the initial login form.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OpenIDAuthenticationFilter.html#setConsumer(org.springframework.security.openid.OpenIDConsumer)">setConsumer</a></span>&#8203;(<a href="OpenIDConsumer.html" title="interface in org.springframework.security.openid">OpenIDConsumer</a>&nbsp;consumer)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OpenIDAuthenticationFilter.html#setRealmMapping(java.util.Map)">setRealmMapping</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;realmMapping)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Maps the <tt>return_to url</tt> to a realm, for example:</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="OpenIDAuthenticationFilter.html#setReturnToUrlParameters(java.util.Set)">setReturnToUrlParameters</a></span>&#8203;(java.util.Set&lt;java.lang.String&gt;&nbsp;returnToUrlParameters)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Specifies any extra parameters submitted along with the identity field which should
be appended to the <code>return_to</code> URL which is assembled by
<a href="OpenIDAuthenticationFilter.html#buildReturnToUrl(javax.servlet.http.HttpServletRequest)"><code>buildReturnToUrl(javax.servlet.http.HttpServletRequest)</code></a>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter">

</a>
<h3>Methods inherited from class&nbsp;org.springframework.security.web.authentication.<a href="../web/authentication/AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">AbstractAuthenticationProcessingFilter</a></h3>
<code><a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#doFilter(javax.servlet.ServletRequest,javax.servlet.ServletResponse,javax.servlet.FilterChain)">doFilter</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#getAllowSessionCreation()">getAllowSessionCreation</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#getAuthenticationManager()">getAuthenticationManager</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#getFailureHandler()">getFailureHandler</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#getRememberMeServices()">getRememberMeServices</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#getSuccessHandler()">getSuccessHandler</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#requiresAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">requiresAuthentication</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#setAllowSessionCreation(boolean)">setAllowSessionCreation</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher)">setApplicationEventPublisher</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#setAuthenticationDetailsSource(org.springframework.security.authentication.AuthenticationDetailsSource)">setAuthenticationDetailsSource</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#setAuthenticationFailureHandler(org.springframework.security.web.authentication.AuthenticationFailureHandler)">setAuthenticationFailureHandler</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#setAuthenticationManager(org.springframework.security.authentication.AuthenticationManager)">setAuthenticationManager</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#setAuthenticationSuccessHandler(org.springframework.security.web.authentication.AuthenticationSuccessHandler)">setAuthenticationSuccessHandler</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#setContinueChainBeforeSuccessfulAuthentication(boolean)">setContinueChainBeforeSuccessfulAuthentication</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#setFilterProcessesUrl(java.lang.String)">setFilterProcessesUrl</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#setMessageSource(org.springframework.context.MessageSource)">setMessageSource</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#setRememberMeServices(org.springframework.security.web.authentication.RememberMeServices)">setRememberMeServices</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#setRequiresAuthenticationRequestMatcher(org.springframework.security.web.util.matcher.RequestMatcher)">setRequiresAuthenticationRequestMatcher</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#setSessionAuthenticationStrategy(org.springframework.security.web.authentication.session.SessionAuthenticationStrategy)">setSessionAuthenticationStrategy</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#successfulAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,javax.servlet.FilterChain,org.springframework.security.core.Authentication)">successfulAuthentication</a>, <a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#unsuccessfulAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,org.springframework.security.core.AuthenticationException)">unsuccessfulAuthentication</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.springframework.web.filter.GenericFilterBean">

</a>
<h3>Methods inherited from class&nbsp;org.springframework.web.filter.GenericFilterBean</h3>
<code>addRequiredProperty, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">

</a>
<h3>Field Detail</h3>
<a id="DEFAULT_CLAIMED_IDENTITY_FIELD">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_CLAIMED_IDENTITY_FIELD</h4>
<pre>public static final&nbsp;java.lang.String DEFAULT_CLAIMED_IDENTITY_FIELD</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.springframework.security.openid.OpenIDAuthenticationFilter.DEFAULT_CLAIMED_IDENTITY_FIELD">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">

</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OpenIDAuthenticationFilter</h4>
<pre>public&nbsp;OpenIDAuthenticationFilter()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="afterPropertiesSet()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>afterPropertiesSet</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;afterPropertiesSet()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>afterPropertiesSet</code>&nbsp;in interface&nbsp;<code>org.springframework.beans.factory.InitializingBean</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#afterPropertiesSet()">afterPropertiesSet</a></code>&nbsp;in class&nbsp;<code><a href="../web/authentication/AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">AbstractAuthenticationProcessingFilter</a></code></dd>
</dl>
</li>
</ul>
<a id="attemptAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>attemptAuthentication</h4>
<pre class="methodSignature">public&nbsp;<a href="../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&nbsp;attemptAuthentication&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request,
                                            javax.servlet.http.HttpServletResponse&nbsp;response)
                                     throws <a href="../core/AuthenticationException.html" title="class in org.springframework.security.core">AuthenticationException</a>,
                                            java.io.IOException</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Authentication has two phases.
<ol>
<li>The initial submission of the claimed OpenID. A redirect to the URL returned
from the consumer will be performed and null will be returned.</li>
<li>The redirection from the OpenID server to the return_to URL, once it has
authenticated the user</li>
</ol></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../web/authentication/AbstractAuthenticationProcessingFilter.html#attemptAuthentication(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">attemptAuthentication</a></code>&nbsp;in class&nbsp;<code><a href="../web/authentication/AbstractAuthenticationProcessingFilter.html" title="class in org.springframework.security.web.authentication">AbstractAuthenticationProcessingFilter</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - from which to extract parameters and perform the authentication</dd>
<dd><code>response</code> - the response, which may be needed if the implementation has to do a
redirect as part of a multi-stage authentication process (such as OpenID).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the authenticated user token, or null if authentication is incomplete.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../core/AuthenticationException.html" title="class in org.springframework.security.core">AuthenticationException</a></code> - if authentication fails.</dd>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a id="lookupRealm(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>lookupRealm</h4>
<pre class="methodSignature">protected&nbsp;java.lang.String&nbsp;lookupRealm&#8203;(java.lang.String&nbsp;returnToUrl)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="buildReturnToUrl(javax.servlet.http.HttpServletRequest)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>buildReturnToUrl</h4>
<pre class="methodSignature">protected&nbsp;java.lang.String&nbsp;buildReturnToUrl&#8203;(javax.servlet.http.HttpServletRequest&nbsp;request)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Builds the <tt>return_to</tt> URL that will be sent to the OpenID service provider.
By default returns the URL of the current request.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - the current request which is being processed by this filter</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The <tt>return_to</tt> URL.</dd>
</dl>
</li>
</ul>
<a id="obtainUsername(javax.servlet.http.HttpServletRequest)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>obtainUsername</h4>
<pre class="methodSignature">protected&nbsp;java.lang.String&nbsp;obtainUsername&#8203;(javax.servlet.http.HttpServletRequest&nbsp;req)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Reads the <tt>claimedIdentityFieldName</tt> from the submitted request.</div>
</li>
</ul>
<a id="setRealmMapping(java.util.Map)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setRealmMapping</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setRealmMapping&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;realmMapping)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Maps the <tt>return_to url</tt> to a realm, for example:
<pre> https://www.example.com/login/openid -&gt; https://www.example.com/realm
 </pre>
If no mapping is provided then the returnToUrl will be parsed to extract the
protocol, hostname and port followed by a trailing slash. This means that
<tt>https://foo.example.com/login/openid</tt> will automatically become
<tt>http://foo.example.com:80/</tt></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>realmMapping</code> - containing returnToUrl -&gt; realm mappings</dd>
</dl>
</li>
</ul>
<a id="setClaimedIdentityFieldName(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setClaimedIdentityFieldName</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setClaimedIdentityFieldName&#8203;(java.lang.String&nbsp;claimedIdentityFieldName)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">The name of the request parameter containing the OpenID identity, as submitted from
the initial login form.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>claimedIdentityFieldName</code> - defaults to "openid_identifier"</dd>
</dl>
</li>
</ul>
<a id="setConsumer(org.springframework.security.openid.OpenIDConsumer)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setConsumer</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setConsumer&#8203;(<a href="OpenIDConsumer.html" title="interface in org.springframework.security.openid">OpenIDConsumer</a>&nbsp;consumer)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
</li>
</ul>
<a id="setReturnToUrlParameters(java.util.Set)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setReturnToUrlParameters</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setReturnToUrlParameters&#8203;(java.util.Set&lt;java.lang.String&gt;&nbsp;returnToUrlParameters)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Specifies any extra parameters submitted along with the identity field which should
be appended to the <code>return_to</code> URL which is assembled by
<a href="OpenIDAuthenticationFilter.html#buildReturnToUrl(javax.servlet.http.HttpServletRequest)"><code>buildReturnToUrl(javax.servlet.http.HttpServletRequest)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>returnToUrlParameters</code> - the set of parameter names. If not set, it will
default to the parameter name used by the <code>RememberMeServices</code> obtained from
the parent class (if one is set).</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="OpenIDAuthenticationFilter.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="OpenIDAuthenticationFilter.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="OpenIDAuthenticationFilter.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="OpenIDAuthenticationFilter.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="OpenIDAuthenticationFilter.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="OpenIDAuthenticationFilter.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="OpenIDAuthenticationFilter.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040ddb69c9f97cf","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
